Skip to content

ENG-13516: Lead API reference titles with rx names for docs search - #7647

Merged
FarhanAliRaza merged 5 commits into
mainfrom
carlos/eng-13516-normalize-component-search
Nov 11, 2026
Merged

ENG-13516: Lead API reference titles with rx names for docs search#7647
FarhanAliRaza merged 5 commits into
mainfrom
carlos/eng-13516-normalize-component-search

Conversation

@carlosabadia

@carlosabadia carlosabadia commented Oct 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Lead generated API reference page titles with the public name users search for, such as rx.State API Reference · Reflex Docs and rx.event.EventSpec API Reference · Reflex Docs. Classes not exported on rx (StateManager) keep their bare name.

Component pages already rank first for raw rx.* queries because #7580 put the identifier in their titles. This applies the same approach to API reference pages. rx.State currently doesn't put its reference page in the top 10 results.

The earlier client-side query rewrite (rx.button → button) is removed. On the live index it lowered component rankings (rx.table 1st → 6th) and returned no results for rx.el.* names.

Verified with a regression test in docs/app/tests/test_routes.py and a local docs build: the titles render as expected, and rx.el.div returns results again. The ranking effect for rx.State shows only after the docs are deployed and re-indexed.

🤖 Generated with Claude Code

@carlosabadia
carlosabadia requested a review from a team as a code owner October 23, 2026 09:43
@carlosabadia carlosabadia added the skip-changelog For doc/internal changes label Oct 23, 2026
@linear-code

linear-code Bot commented Oct 23, 2026

Copy link
Copy Markdown

ENG-13516

cubic-dev-ai[bot]
cubic-dev-ai Bot reviewed Oct 23, 2026
View reviewed changes

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 4 files

Tip: Get a Slack DM when cubic finishes reviewing your PRs. Connect Slack

View guided diff | Turn on auto-fix | Re-trigger cubic

@greptile-apps

greptile-apps Bot commented Oct 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The PR appears safe to merge; no actionable issues were found.

Summary

API reference page titles now lead with public names such as rx.State.

  • API reference search titles now start with each class’s public name.

The earlier, unnumbered test-maintenance finding is addressed: the source-slicing test has been removed.

Reviews (4) · Last reviewed commit: "Make the API reference name helper priva..." · Reviewed by Greptile

greptile-apps[bot]
greptile-apps Bot reviewed Oct 23, 2026
View reviewed changes
Comment thread tests/units/reflex_site_shared/test_algolia.py Resolved
cubic-dev-ai[bot]
cubic-dev-ai Bot reviewed Oct 23, 2026
View reviewed changes

@cubic-dev-ai cubic-dev-ai Bot left a comment •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 5 files (changes from recent commits).

Reply with feedback, questions, or to request a fix.

View guided diff | Turn on auto-fix | Re-trigger cubic

Comment thread tests/units/reflex_site_shared/test_algolia.py Resolved
@codspeed

codspeed Bot commented Oct 23, 2026 •
edited
Loading

Copy link
Copy Markdown

Merging this PR will degrade performance by 5.09%

2 warnings

⚠️ 15 benchmarks are dominated by system calls

System calls cannot be simulated consistently and are left out of the measure. The reported value understates the real cost. Switch to the Walltime instrument to measure them.

Learn more about system calls

See affected benchmarks

⚠️ 3 benchmarks with a significant change ran on different hardware

Their base and head results were measured on machines with a different CPU, core count or memory, so the changes might not come from the code. Run base and head on the same runner type.

Learn more about Macro Runners

See affected benchmarks

❌ 3 regressed benchmarks
✅ 148 untouched benchmarks

Warning

Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

Benchmark BASE HEAD Efficiency
❌ test_route_matching[10] 50.4 µs 53.3 µs -5.42%
❌ test_route_matching[1000] 47.8 µs 50.4 µs -5.32%
❌ test_process_event_burst_independent_tokens[1] 2.7 ms 2.9 ms -4.52%

Tip

Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.

Comparing carlos/eng-13516-normalize-component-search (94a486a) with main (2d71015)

Open in CodSpeed

@masenf masenf added the bug Something isn't working label Oct 27, 2026
@FarhanAliRaza FarhanAliRaza added the on deck PRs lined up to review / merge next label Nov 4, 2026
carlosabadia and others added 2 commits November 11, 2026 09:57
@carlosabadia @claude
Drop docs search query rewrite; lead API reference titles with rx names
91fd78a 
Sending rx.* queries raw ranks component pages higher than the rewritten
words, and the rewrite returned no results for rx.el.* names. Put the
public name in API reference titles instead (rx.State API Reference), the
same approach component titles use.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@carlosabadia @claude
Make the API reference name helper private
94a486a 
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@carlosabadia
carlosabadia requested a review from Alek99 as a code owner November 11, 2026 09:11
@carlosabadia carlosabadia changed the title ENG-13516: Normalize component identifiers in docs search ENG-13516: Lead API reference titles with rx names for docs search Nov 11, 2026
@FarhanAliRaza
FarhanAliRaza merged commit b4d4cc8 into main Nov 11, 2026
166 of 167 checks passed
@FarhanAliRaza
FarhanAliRaza deleted the carlos/eng-13516-normalize-component-search branch November 11, 2026 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments
@cubic-dev-ai cubic-dev-ai[bot] cubic-dev-ai[bot] left review comments
@FarhanAliRaza FarhanAliRaza FarhanAliRaza approved these changes
@Alek99 Alek99 Awaiting requested review from Alek99 Alek99 is a code owner

Assignees

No one assigned

Labels

bug Something isn't working on deck PRs lined up to review / merge next skip-changelog For doc/internal changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@carlosabadia @FarhanAliRaza @masenf